<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.net.smtp;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.Writer;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.commons.net.io.DotTerminatedMessageWriter;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/***<a name="line.26"></a>
<span class="sourceLineNo">027</span> * SMTPClient encapsulates all the functionality necessary to send files<a name="line.27"></a>
<span class="sourceLineNo">028</span> * through an SMTP server.  This class takes care of all<a name="line.28"></a>
<span class="sourceLineNo">029</span> * low level details of interacting with an SMTP server and provides<a name="line.29"></a>
<span class="sourceLineNo">030</span> * a convenient higher level interface.  As with all classes derived<a name="line.30"></a>
<span class="sourceLineNo">031</span> * from {@link org.apache.commons.net.SocketClient},<a name="line.31"></a>
<span class="sourceLineNo">032</span> * you must first connect to the server with<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@link org.apache.commons.net.SocketClient#connect  connect }<a name="line.33"></a>
<span class="sourceLineNo">034</span> * before doing anything, and finally<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link org.apache.commons.net.SocketClient#disconnect  disconnect }<a name="line.35"></a>
<span class="sourceLineNo">036</span> * after you're completely finished interacting with the server.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Then you need to check the SMTP reply code to see if the connection<a name="line.37"></a>
<span class="sourceLineNo">038</span> * was successful.  For example:<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;pre&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> *    try {<a name="line.40"></a>
<span class="sourceLineNo">041</span> *      int reply;<a name="line.41"></a>
<span class="sourceLineNo">042</span> *      client.connect("mail.foobar.com");<a name="line.42"></a>
<span class="sourceLineNo">043</span> *      System.out.print(client.getReplyString());<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> *      // After connection attempt, you should check the reply code to verify<a name="line.45"></a>
<span class="sourceLineNo">046</span> *      // success.<a name="line.46"></a>
<span class="sourceLineNo">047</span> *      reply = client.getReplyCode();<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> *      if(!SMTPReply.isPositiveCompletion(reply)) {<a name="line.49"></a>
<span class="sourceLineNo">050</span> *        client.disconnect();<a name="line.50"></a>
<span class="sourceLineNo">051</span> *        System.err.println("SMTP server refused connection.");<a name="line.51"></a>
<span class="sourceLineNo">052</span> *        System.exit(1);<a name="line.52"></a>
<span class="sourceLineNo">053</span> *      }<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> *      // Do useful stuff here.<a name="line.55"></a>
<span class="sourceLineNo">056</span> *      ...<a name="line.56"></a>
<span class="sourceLineNo">057</span> *    } catch(IOException e) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> *      if(client.isConnected()) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> *        try {<a name="line.59"></a>
<span class="sourceLineNo">060</span> *          client.disconnect();<a name="line.60"></a>
<span class="sourceLineNo">061</span> *        } catch(IOException f) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> *          // do nothing<a name="line.62"></a>
<span class="sourceLineNo">063</span> *        }<a name="line.63"></a>
<span class="sourceLineNo">064</span> *      }<a name="line.64"></a>
<span class="sourceLineNo">065</span> *      System.err.println("Could not connect to server.");<a name="line.65"></a>
<span class="sourceLineNo">066</span> *      e.printStackTrace();<a name="line.66"></a>
<span class="sourceLineNo">067</span> *      System.exit(1);<a name="line.67"></a>
<span class="sourceLineNo">068</span> *    }<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;/pre&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;p&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Immediately after connecting is the only real time you need to check the<a name="line.71"></a>
<span class="sourceLineNo">072</span> * reply code (because connect is of type void).  The convention for all the<a name="line.72"></a>
<span class="sourceLineNo">073</span> * SMTP command methods in SMTPClient is such that they either return a<a name="line.73"></a>
<span class="sourceLineNo">074</span> * boolean value or some other value.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * The boolean methods return true on a successful completion reply from<a name="line.75"></a>
<span class="sourceLineNo">076</span> * the SMTP server and false on a reply resulting in an error condition or<a name="line.76"></a>
<span class="sourceLineNo">077</span> * failure.  The methods returning a value other than boolean return a value<a name="line.77"></a>
<span class="sourceLineNo">078</span> * containing the higher level data produced by the SMTP command, or null if a<a name="line.78"></a>
<span class="sourceLineNo">079</span> * reply resulted in an error condition or failure.  If you want to access<a name="line.79"></a>
<span class="sourceLineNo">080</span> * the exact SMTP reply code causing a success or failure, you must call<a name="line.80"></a>
<span class="sourceLineNo">081</span> * {@link org.apache.commons.net.smtp.SMTP#getReplyCode  getReplyCode } after<a name="line.81"></a>
<span class="sourceLineNo">082</span> * a success or failure.<a name="line.82"></a>
<span class="sourceLineNo">083</span> * &lt;p&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span> * You should keep in mind that the SMTP server may choose to prematurely<a name="line.84"></a>
<span class="sourceLineNo">085</span> * close a connection for various reasons.  The SMTPClient class will detect a<a name="line.85"></a>
<span class="sourceLineNo">086</span> * premature SMTP server connection closing when it receives a<a name="line.86"></a>
<span class="sourceLineNo">087</span> * {@link org.apache.commons.net.smtp.SMTPReply#SERVICE_NOT_AVAILABLE SMTPReply.SERVICE_NOT_AVAILABLE }<a name="line.87"></a>
<span class="sourceLineNo">088</span> *  response to a command.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * When that occurs, the method encountering that reply will throw<a name="line.89"></a>
<span class="sourceLineNo">090</span> * an {@link org.apache.commons.net.smtp.SMTPConnectionClosedException}<a name="line.90"></a>
<span class="sourceLineNo">091</span> * .<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;code&gt;SMTPConectionClosedException&lt;/code&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span> * is a subclass of &lt;code&gt; IOException &lt;/code&gt; and therefore need not be<a name="line.93"></a>
<span class="sourceLineNo">094</span> * caught separately, but if you are going to catch it separately, its<a name="line.94"></a>
<span class="sourceLineNo">095</span> * catch block must appear before the more general &lt;code&gt; IOException &lt;/code&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span> * catch block.  When you encounter an<a name="line.96"></a>
<span class="sourceLineNo">097</span> * {@link org.apache.commons.net.smtp.SMTPConnectionClosedException}<a name="line.97"></a>
<span class="sourceLineNo">098</span> * , you must disconnect the connection with<a name="line.98"></a>
<span class="sourceLineNo">099</span> * {@link #disconnect  disconnect() } to properly clean up the<a name="line.99"></a>
<span class="sourceLineNo">100</span> * system resources used by SMTPClient.  Before disconnecting, you may check<a name="line.100"></a>
<span class="sourceLineNo">101</span> * the last reply code and text with<a name="line.101"></a>
<span class="sourceLineNo">102</span> * {@link org.apache.commons.net.smtp.SMTP#getReplyCode  getReplyCode },<a name="line.102"></a>
<span class="sourceLineNo">103</span> * {@link org.apache.commons.net.smtp.SMTP#getReplyString  getReplyString },<a name="line.103"></a>
<span class="sourceLineNo">104</span> * and<a name="line.104"></a>
<span class="sourceLineNo">105</span> * {@link org.apache.commons.net.smtp.SMTP#getReplyStrings getReplyStrings}.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * &lt;p&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> * Rather than list it separately for each method, we mention here that<a name="line.107"></a>
<span class="sourceLineNo">108</span> * every method communicating with the server and throwing an IOException<a name="line.108"></a>
<span class="sourceLineNo">109</span> * can also throw a<a name="line.109"></a>
<span class="sourceLineNo">110</span> * {@link org.apache.commons.net.MalformedServerReplyException}<a name="line.110"></a>
<span class="sourceLineNo">111</span> * , which is a subclass<a name="line.111"></a>
<span class="sourceLineNo">112</span> * of IOException.  A MalformedServerReplyException will be thrown when<a name="line.112"></a>
<span class="sourceLineNo">113</span> * the reply received from the server deviates enough from the protocol<a name="line.113"></a>
<span class="sourceLineNo">114</span> * specification that it cannot be interpreted in a useful manner despite<a name="line.114"></a>
<span class="sourceLineNo">115</span> * attempts to be as lenient as possible.<a name="line.115"></a>
<span class="sourceLineNo">116</span> * &lt;p&gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span> * &lt;p&gt;<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @see SMTP<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @see SimpleSMTPHeader<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @see RelayPath<a name="line.120"></a>
<span class="sourceLineNo">121</span> * @see SMTPConnectionClosedException<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @see org.apache.commons.net.MalformedServerReplyException<a name="line.122"></a>
<span class="sourceLineNo">123</span> ***/<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span>public class SMTPClient extends SMTP<a name="line.125"></a>
<span class="sourceLineNo">126</span>{<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>    /**<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * Default SMTPClient constructor.  Creates a new SMTPClient instance.<a name="line.129"></a>
<span class="sourceLineNo">130</span>     */<a name="line.130"></a>
<span class="sourceLineNo">131</span>    public SMTPClient() {  }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>    /**<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * Overloaded constructor that takes an encoding specification<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * @param encoding The encoding to use<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * @since 2.0<a name="line.136"></a>
<span class="sourceLineNo">137</span>     */<a name="line.137"></a>
<span class="sourceLineNo">138</span>    public SMTPClient(String encoding) {<a name="line.138"></a>
<span class="sourceLineNo">139</span>        super(encoding);<a name="line.139"></a>
<span class="sourceLineNo">140</span>    }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span>    /***<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * At least one SMTPClient method ({@link #sendMessageData  sendMessageData })<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * does not complete the entire sequence of SMTP commands to complete a<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * transaction.  These types of commands require some action by the<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * programmer after the reception of a positive intermediate command.<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * After the programmer's code completes its actions, it must call this<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * method to receive the completion reply from the server and verify the<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * success of the entire transaction.<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * &lt;p&gt;<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * For example,<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * &lt;pre&gt;<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * writer = client.sendMessage();<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * if(writer == null) // failure<a name="line.155"></a>
<span class="sourceLineNo">156</span>     *   return false;<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * header =<a name="line.157"></a>
<span class="sourceLineNo">158</span>     *  new SimpleSMTPHeader("foobar@foo.com", "foo@foobar.com", "Re: Foo");<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * writer.write(header.toString());<a name="line.159"></a>
<span class="sourceLineNo">160</span>     * writer.write("This is just a test");<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * writer.close();<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * if(!client.completePendingCommand()) // failure<a name="line.162"></a>
<span class="sourceLineNo">163</span>     *   return false;<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * &lt;/pre&gt;<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * &lt;p&gt;<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * @return True if successfully completed, false if not.<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * @exception SMTPConnectionClosedException<a name="line.167"></a>
<span class="sourceLineNo">168</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *      of the client being idle or some other reason causing the server<a name="line.169"></a>
<span class="sourceLineNo">170</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.170"></a>
<span class="sourceLineNo">171</span>     *      as an IOException or independently as itself.<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.172"></a>
<span class="sourceLineNo">173</span>     *      command to the server or receiving a reply from the server.<a name="line.173"></a>
<span class="sourceLineNo">174</span>     ***/<a name="line.174"></a>
<span class="sourceLineNo">175</span>    public boolean completePendingCommand() throws IOException<a name="line.175"></a>
<span class="sourceLineNo">176</span>    {<a name="line.176"></a>
<span class="sourceLineNo">177</span>        return SMTPReply.isPositiveCompletion(getReply());<a name="line.177"></a>
<span class="sourceLineNo">178</span>    }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span>    /***<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * Login to the SMTP server by sending the HELO command with the<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * given hostname as an argument.  Before performing any mail commands,<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * you must first login.<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * &lt;p&gt;<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * @param hostname  The hostname with which to greet the SMTP server.<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * @return True if successfully completed, false if not.<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * @exception SMTPConnectionClosedException<a name="line.188"></a>
<span class="sourceLineNo">189</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.189"></a>
<span class="sourceLineNo">190</span>     *      of the client being idle or some other reason causing the server<a name="line.190"></a>
<span class="sourceLineNo">191</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.191"></a>
<span class="sourceLineNo">192</span>     *      as an IOException or independently as itself.<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.193"></a>
<span class="sourceLineNo">194</span>     *      command to the server or receiving a reply from the server.<a name="line.194"></a>
<span class="sourceLineNo">195</span>     ***/<a name="line.195"></a>
<span class="sourceLineNo">196</span>    public boolean login(String hostname) throws IOException<a name="line.196"></a>
<span class="sourceLineNo">197</span>    {<a name="line.197"></a>
<span class="sourceLineNo">198</span>        return SMTPReply.isPositiveCompletion(helo(hostname));<a name="line.198"></a>
<span class="sourceLineNo">199</span>    }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span>    /***<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * Login to the SMTP server by sending the HELO command with the<a name="line.203"></a>
<span class="sourceLineNo">204</span>     * client hostname as an argument.  Before performing any mail commands,<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * you must first login.<a name="line.205"></a>
<span class="sourceLineNo">206</span>     * &lt;p&gt;<a name="line.206"></a>
<span class="sourceLineNo">207</span>     * @return True if successfully completed, false if not.<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * @exception SMTPConnectionClosedException<a name="line.208"></a>
<span class="sourceLineNo">209</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.209"></a>
<span class="sourceLineNo">210</span>     *      of the client being idle or some other reason causing the server<a name="line.210"></a>
<span class="sourceLineNo">211</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.211"></a>
<span class="sourceLineNo">212</span>     *      as an IOException or independently as itself.<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.213"></a>
<span class="sourceLineNo">214</span>     *      command to the server or receiving a reply from the server.<a name="line.214"></a>
<span class="sourceLineNo">215</span>     ***/<a name="line.215"></a>
<span class="sourceLineNo">216</span>    public boolean login() throws IOException<a name="line.216"></a>
<span class="sourceLineNo">217</span>    {<a name="line.217"></a>
<span class="sourceLineNo">218</span>        String name;<a name="line.218"></a>
<span class="sourceLineNo">219</span>        InetAddress host;<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span>        host = getLocalAddress();<a name="line.221"></a>
<span class="sourceLineNo">222</span>        name = host.getHostName();<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span>        if (name == null) {<a name="line.224"></a>
<span class="sourceLineNo">225</span>            return false;<a name="line.225"></a>
<span class="sourceLineNo">226</span>        }<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span>        return SMTPReply.isPositiveCompletion(helo(name));<a name="line.228"></a>
<span class="sourceLineNo">229</span>    }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span>    /***<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * Set the sender of a message using the SMTP MAIL command, specifying<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * a reverse relay path.  The sender must be set first before any<a name="line.234"></a>
<span class="sourceLineNo">235</span>     * recipients may be specified, otherwise the mail server will reject<a name="line.235"></a>
<span class="sourceLineNo">236</span>     * your commands.<a name="line.236"></a>
<span class="sourceLineNo">237</span>     * &lt;p&gt;<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * @param path  The reverse relay path pointing back to the sender.<a name="line.238"></a>
<span class="sourceLineNo">239</span>     * @return True if successfully completed, false if not.<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * @exception SMTPConnectionClosedException<a name="line.240"></a>
<span class="sourceLineNo">241</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.241"></a>
<span class="sourceLineNo">242</span>     *      of the client being idle or some other reason causing the server<a name="line.242"></a>
<span class="sourceLineNo">243</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.243"></a>
<span class="sourceLineNo">244</span>     *      as an IOException or independently as itself.<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.245"></a>
<span class="sourceLineNo">246</span>     *      command to the server or receiving a reply from the server.<a name="line.246"></a>
<span class="sourceLineNo">247</span>     ***/<a name="line.247"></a>
<span class="sourceLineNo">248</span>    public boolean setSender(RelayPath path) throws IOException<a name="line.248"></a>
<span class="sourceLineNo">249</span>    {<a name="line.249"></a>
<span class="sourceLineNo">250</span>        return SMTPReply.isPositiveCompletion(mail(path.toString()));<a name="line.250"></a>
<span class="sourceLineNo">251</span>    }<a name="line.251"></a>
<span class="sourceLineNo">252</span><a name="line.252"></a>
<span class="sourceLineNo">253</span><a name="line.253"></a>
<span class="sourceLineNo">254</span>    /***<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * Set the sender of a message using the SMTP MAIL command, specifying<a name="line.255"></a>
<span class="sourceLineNo">256</span>     * the sender's email address. The sender must be set first before any<a name="line.256"></a>
<span class="sourceLineNo">257</span>     * recipients may be specified, otherwise the mail server will reject<a name="line.257"></a>
<span class="sourceLineNo">258</span>     * your commands.<a name="line.258"></a>
<span class="sourceLineNo">259</span>     * &lt;p&gt;<a name="line.259"></a>
<span class="sourceLineNo">260</span>     * @param address  The sender's email address.<a name="line.260"></a>
<span class="sourceLineNo">261</span>     * @return True if successfully completed, false if not.<a name="line.261"></a>
<span class="sourceLineNo">262</span>     * @exception SMTPConnectionClosedException<a name="line.262"></a>
<span class="sourceLineNo">263</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.263"></a>
<span class="sourceLineNo">264</span>     *      of the client being idle or some other reason causing the server<a name="line.264"></a>
<span class="sourceLineNo">265</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.265"></a>
<span class="sourceLineNo">266</span>     *      as an IOException or independently as itself.<a name="line.266"></a>
<span class="sourceLineNo">267</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.267"></a>
<span class="sourceLineNo">268</span>     *      command to the server or receiving a reply from the server.<a name="line.268"></a>
<span class="sourceLineNo">269</span>     ***/<a name="line.269"></a>
<span class="sourceLineNo">270</span>    public boolean setSender(String address) throws IOException<a name="line.270"></a>
<span class="sourceLineNo">271</span>    {<a name="line.271"></a>
<span class="sourceLineNo">272</span>        return SMTPReply.isPositiveCompletion(mail("&lt;" + address + "&gt;"));<a name="line.272"></a>
<span class="sourceLineNo">273</span>    }<a name="line.273"></a>
<span class="sourceLineNo">274</span><a name="line.274"></a>
<span class="sourceLineNo">275</span><a name="line.275"></a>
<span class="sourceLineNo">276</span>    /***<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * Add a recipient for a message using the SMTP RCPT command, specifying<a name="line.277"></a>
<span class="sourceLineNo">278</span>     * a forward relay path.  The sender must be set first before any<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * recipients may be specified, otherwise the mail server will reject<a name="line.279"></a>
<span class="sourceLineNo">280</span>     * your commands.<a name="line.280"></a>
<span class="sourceLineNo">281</span>     * &lt;p&gt;<a name="line.281"></a>
<span class="sourceLineNo">282</span>     * @param path  The forward relay path pointing to the recipient.<a name="line.282"></a>
<span class="sourceLineNo">283</span>     * @return True if successfully completed, false if not.<a name="line.283"></a>
<span class="sourceLineNo">284</span>     * @exception SMTPConnectionClosedException<a name="line.284"></a>
<span class="sourceLineNo">285</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.285"></a>
<span class="sourceLineNo">286</span>     *      of the client being idle or some other reason causing the server<a name="line.286"></a>
<span class="sourceLineNo">287</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.287"></a>
<span class="sourceLineNo">288</span>     *      as an IOException or independently as itself.<a name="line.288"></a>
<span class="sourceLineNo">289</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.289"></a>
<span class="sourceLineNo">290</span>     *      command to the server or receiving a reply from the server.<a name="line.290"></a>
<span class="sourceLineNo">291</span>     ***/<a name="line.291"></a>
<span class="sourceLineNo">292</span>    public boolean addRecipient(RelayPath path) throws IOException<a name="line.292"></a>
<span class="sourceLineNo">293</span>    {<a name="line.293"></a>
<span class="sourceLineNo">294</span>        return SMTPReply.isPositiveCompletion(rcpt(path.toString()));<a name="line.294"></a>
<span class="sourceLineNo">295</span>    }<a name="line.295"></a>
<span class="sourceLineNo">296</span><a name="line.296"></a>
<span class="sourceLineNo">297</span><a name="line.297"></a>
<span class="sourceLineNo">298</span>    /***<a name="line.298"></a>
<span class="sourceLineNo">299</span>     * Add a recipient for a message using the SMTP RCPT command, the<a name="line.299"></a>
<span class="sourceLineNo">300</span>     * recipient's email address.  The sender must be set first before any<a name="line.300"></a>
<span class="sourceLineNo">301</span>     * recipients may be specified, otherwise the mail server will reject<a name="line.301"></a>
<span class="sourceLineNo">302</span>     * your commands.<a name="line.302"></a>
<span class="sourceLineNo">303</span>     * &lt;p&gt;<a name="line.303"></a>
<span class="sourceLineNo">304</span>     * @param address  The recipient's email address.<a name="line.304"></a>
<span class="sourceLineNo">305</span>     * @return True if successfully completed, false if not.<a name="line.305"></a>
<span class="sourceLineNo">306</span>     * @exception SMTPConnectionClosedException<a name="line.306"></a>
<span class="sourceLineNo">307</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.307"></a>
<span class="sourceLineNo">308</span>     *      of the client being idle or some other reason causing the server<a name="line.308"></a>
<span class="sourceLineNo">309</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.309"></a>
<span class="sourceLineNo">310</span>     *      as an IOException or independently as itself.<a name="line.310"></a>
<span class="sourceLineNo">311</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.311"></a>
<span class="sourceLineNo">312</span>     *      command to the server or receiving a reply from the server.<a name="line.312"></a>
<span class="sourceLineNo">313</span>     ***/<a name="line.313"></a>
<span class="sourceLineNo">314</span>    public boolean addRecipient(String address) throws IOException<a name="line.314"></a>
<span class="sourceLineNo">315</span>    {<a name="line.315"></a>
<span class="sourceLineNo">316</span>        return SMTPReply.isPositiveCompletion(rcpt("&lt;" + address + "&gt;"));<a name="line.316"></a>
<span class="sourceLineNo">317</span>    }<a name="line.317"></a>
<span class="sourceLineNo">318</span><a name="line.318"></a>
<span class="sourceLineNo">319</span><a name="line.319"></a>
<span class="sourceLineNo">320</span><a name="line.320"></a>
<span class="sourceLineNo">321</span>    /***<a name="line.321"></a>
<span class="sourceLineNo">322</span>     * Send the SMTP DATA command in preparation to send an email message.<a name="line.322"></a>
<span class="sourceLineNo">323</span>     * This method returns a DotTerminatedMessageWriter instance to which<a name="line.323"></a>
<span class="sourceLineNo">324</span>     * the message can be written.  Null is returned if the DATA command<a name="line.324"></a>
<span class="sourceLineNo">325</span>     * fails.<a name="line.325"></a>
<span class="sourceLineNo">326</span>     * &lt;p&gt;<a name="line.326"></a>
<span class="sourceLineNo">327</span>     * You must not issue any commands to the SMTP server (i.e., call any<a name="line.327"></a>
<span class="sourceLineNo">328</span>     * (other methods) until you finish writing to the returned Writer<a name="line.328"></a>
<span class="sourceLineNo">329</span>     * instance and close it.  The SMTP protocol uses the same stream for<a name="line.329"></a>
<span class="sourceLineNo">330</span>     * issuing commands as it does for returning results.  Therefore the<a name="line.330"></a>
<span class="sourceLineNo">331</span>     * returned Writer actually writes directly to the SMTP connection.<a name="line.331"></a>
<span class="sourceLineNo">332</span>     * After you close the writer, you can execute new commands.  If you<a name="line.332"></a>
<span class="sourceLineNo">333</span>     * do not follow these requirements your program will not work properly.<a name="line.333"></a>
<span class="sourceLineNo">334</span>     * &lt;p&gt;<a name="line.334"></a>
<span class="sourceLineNo">335</span>     * You can use the provided<a name="line.335"></a>
<span class="sourceLineNo">336</span>     * {@link org.apache.commons.net.smtp.SimpleSMTPHeader}<a name="line.336"></a>
<span class="sourceLineNo">337</span>     * class to construct a bare minimum header.<a name="line.337"></a>
<span class="sourceLineNo">338</span>     * To construct more complicated headers you should<a name="line.338"></a>
<span class="sourceLineNo">339</span>     * refer to RFC 822.  When the Java Mail API is finalized, you will be<a name="line.339"></a>
<span class="sourceLineNo">340</span>     * able to use it to compose fully compliant Internet text messages.<a name="line.340"></a>
<span class="sourceLineNo">341</span>     * The DotTerminatedMessageWriter takes care of doubling line-leading<a name="line.341"></a>
<span class="sourceLineNo">342</span>     * dots and ending the message with a single dot upon closing, so all<a name="line.342"></a>
<span class="sourceLineNo">343</span>     * you have to worry about is writing the header and the message.<a name="line.343"></a>
<span class="sourceLineNo">344</span>     * &lt;p&gt;<a name="line.344"></a>
<span class="sourceLineNo">345</span>     * Upon closing the returned Writer, you need to call<a name="line.345"></a>
<span class="sourceLineNo">346</span>     * {@link #completePendingCommand  completePendingCommand() }<a name="line.346"></a>
<span class="sourceLineNo">347</span>     * to finalize the transaction and verify its success or failure from<a name="line.347"></a>
<span class="sourceLineNo">348</span>     * the server reply.<a name="line.348"></a>
<span class="sourceLineNo">349</span>     * &lt;p&gt;<a name="line.349"></a>
<span class="sourceLineNo">350</span>     * @return A DotTerminatedMessageWriter to which the message (including<a name="line.350"></a>
<span class="sourceLineNo">351</span>     *      header) can be written.  Returns null if the command fails.<a name="line.351"></a>
<span class="sourceLineNo">352</span>     * @exception SMTPConnectionClosedException<a name="line.352"></a>
<span class="sourceLineNo">353</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.353"></a>
<span class="sourceLineNo">354</span>     *      of the client being idle or some other reason causing the server<a name="line.354"></a>
<span class="sourceLineNo">355</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.355"></a>
<span class="sourceLineNo">356</span>     *      as an IOException or independently as itself.<a name="line.356"></a>
<span class="sourceLineNo">357</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.357"></a>
<span class="sourceLineNo">358</span>     *      command to the server or receiving a reply from the server.<a name="line.358"></a>
<span class="sourceLineNo">359</span>     ***/<a name="line.359"></a>
<span class="sourceLineNo">360</span>    public Writer sendMessageData() throws IOException<a name="line.360"></a>
<span class="sourceLineNo">361</span>    {<a name="line.361"></a>
<span class="sourceLineNo">362</span>        if (!SMTPReply.isPositiveIntermediate(data())) {<a name="line.362"></a>
<span class="sourceLineNo">363</span>            return null;<a name="line.363"></a>
<span class="sourceLineNo">364</span>        }<a name="line.364"></a>
<span class="sourceLineNo">365</span><a name="line.365"></a>
<span class="sourceLineNo">366</span>        return new DotTerminatedMessageWriter(_writer);<a name="line.366"></a>
<span class="sourceLineNo">367</span>    }<a name="line.367"></a>
<span class="sourceLineNo">368</span><a name="line.368"></a>
<span class="sourceLineNo">369</span><a name="line.369"></a>
<span class="sourceLineNo">370</span>    /***<a name="line.370"></a>
<span class="sourceLineNo">371</span>     * A convenience method for sending short messages.  This method fetches<a name="line.371"></a>
<span class="sourceLineNo">372</span>     * the Writer returned by {@link #sendMessageData  sendMessageData() }<a name="line.372"></a>
<span class="sourceLineNo">373</span>     * and writes the specified String to it.  After writing the message,<a name="line.373"></a>
<span class="sourceLineNo">374</span>     * this method calls {@link #completePendingCommand completePendingCommand() }<a name="line.374"></a>
<span class="sourceLineNo">375</span>     *  to finalize the transaction and returns<a name="line.375"></a>
<span class="sourceLineNo">376</span>     * its success or failure.<a name="line.376"></a>
<span class="sourceLineNo">377</span>     * &lt;p&gt;<a name="line.377"></a>
<span class="sourceLineNo">378</span>     * @param message  The short email message to send.<a name="line.378"></a>
<span class="sourceLineNo">379</span>     * @return True if successfully completed, false if not.<a name="line.379"></a>
<span class="sourceLineNo">380</span>     * @exception SMTPConnectionClosedException<a name="line.380"></a>
<span class="sourceLineNo">381</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.381"></a>
<span class="sourceLineNo">382</span>     *      of the client being idle or some other reason causing the server<a name="line.382"></a>
<span class="sourceLineNo">383</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.383"></a>
<span class="sourceLineNo">384</span>     *      as an IOException or independently as itself.<a name="line.384"></a>
<span class="sourceLineNo">385</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.385"></a>
<span class="sourceLineNo">386</span>     *      command to the server or receiving a reply from the server.<a name="line.386"></a>
<span class="sourceLineNo">387</span>     ***/<a name="line.387"></a>
<span class="sourceLineNo">388</span>    public boolean sendShortMessageData(String message) throws IOException<a name="line.388"></a>
<span class="sourceLineNo">389</span>    {<a name="line.389"></a>
<span class="sourceLineNo">390</span>        Writer writer;<a name="line.390"></a>
<span class="sourceLineNo">391</span><a name="line.391"></a>
<span class="sourceLineNo">392</span>        writer = sendMessageData();<a name="line.392"></a>
<span class="sourceLineNo">393</span><a name="line.393"></a>
<span class="sourceLineNo">394</span>        if (writer == null) {<a name="line.394"></a>
<span class="sourceLineNo">395</span>            return false;<a name="line.395"></a>
<span class="sourceLineNo">396</span>        }<a name="line.396"></a>
<span class="sourceLineNo">397</span><a name="line.397"></a>
<span class="sourceLineNo">398</span>        writer.write(message);<a name="line.398"></a>
<span class="sourceLineNo">399</span>        writer.close();<a name="line.399"></a>
<span class="sourceLineNo">400</span><a name="line.400"></a>
<span class="sourceLineNo">401</span>        return completePendingCommand();<a name="line.401"></a>
<span class="sourceLineNo">402</span>    }<a name="line.402"></a>
<span class="sourceLineNo">403</span><a name="line.403"></a>
<span class="sourceLineNo">404</span><a name="line.404"></a>
<span class="sourceLineNo">405</span>    /***<a name="line.405"></a>
<span class="sourceLineNo">406</span>     * A convenience method for a sending short email without having to<a name="line.406"></a>
<span class="sourceLineNo">407</span>     * explicitly set the sender and recipient(s).  This method<a name="line.407"></a>
<span class="sourceLineNo">408</span>     * sets the sender and recipient using<a name="line.408"></a>
<span class="sourceLineNo">409</span>     * {@link #setSender  setSender } and<a name="line.409"></a>
<span class="sourceLineNo">410</span>     * {@link #addRecipient  addRecipient }, and then sends the<a name="line.410"></a>
<span class="sourceLineNo">411</span>     * message using {@link #sendShortMessageData  sendShortMessageData }.<a name="line.411"></a>
<span class="sourceLineNo">412</span>     * &lt;p&gt;<a name="line.412"></a>
<span class="sourceLineNo">413</span>     * @param sender  The email address of the sender.<a name="line.413"></a>
<span class="sourceLineNo">414</span>     * @param recipient  The email address of the recipient.<a name="line.414"></a>
<span class="sourceLineNo">415</span>     * @param message  The short email message to send.<a name="line.415"></a>
<span class="sourceLineNo">416</span>     * @return True if successfully completed, false if not.<a name="line.416"></a>
<span class="sourceLineNo">417</span>     * @exception SMTPConnectionClosedException<a name="line.417"></a>
<span class="sourceLineNo">418</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.418"></a>
<span class="sourceLineNo">419</span>     *      of the client being idle or some other reason causing the server<a name="line.419"></a>
<span class="sourceLineNo">420</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.420"></a>
<span class="sourceLineNo">421</span>     *      as an IOException or independently as itself.<a name="line.421"></a>
<span class="sourceLineNo">422</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.422"></a>
<span class="sourceLineNo">423</span>     *      command to the server or receiving a reply from the server.<a name="line.423"></a>
<span class="sourceLineNo">424</span>     ***/<a name="line.424"></a>
<span class="sourceLineNo">425</span>    public boolean sendSimpleMessage(String sender, String recipient,<a name="line.425"></a>
<span class="sourceLineNo">426</span>                                     String message)<a name="line.426"></a>
<span class="sourceLineNo">427</span>    throws IOException<a name="line.427"></a>
<span class="sourceLineNo">428</span>    {<a name="line.428"></a>
<span class="sourceLineNo">429</span>        if (!setSender(sender)) {<a name="line.429"></a>
<span class="sourceLineNo">430</span>            return false;<a name="line.430"></a>
<span class="sourceLineNo">431</span>        }<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
<span class="sourceLineNo">433</span>        if (!addRecipient(recipient)) {<a name="line.433"></a>
<span class="sourceLineNo">434</span>            return false;<a name="line.434"></a>
<span class="sourceLineNo">435</span>        }<a name="line.435"></a>
<span class="sourceLineNo">436</span><a name="line.436"></a>
<span class="sourceLineNo">437</span>        return sendShortMessageData(message);<a name="line.437"></a>
<span class="sourceLineNo">438</span>    }<a name="line.438"></a>
<span class="sourceLineNo">439</span><a name="line.439"></a>
<span class="sourceLineNo">440</span><a name="line.440"></a>
<span class="sourceLineNo">441</span><a name="line.441"></a>
<span class="sourceLineNo">442</span>    /***<a name="line.442"></a>
<span class="sourceLineNo">443</span>     * A convenience method for a sending short email without having to<a name="line.443"></a>
<span class="sourceLineNo">444</span>     * explicitly set the sender and recipient(s).  This method<a name="line.444"></a>
<span class="sourceLineNo">445</span>     * sets the sender and recipients using<a name="line.445"></a>
<span class="sourceLineNo">446</span>     * {@link #setSender  setSender } and<a name="line.446"></a>
<span class="sourceLineNo">447</span>     * {@link #addRecipient  addRecipient }, and then sends the<a name="line.447"></a>
<span class="sourceLineNo">448</span>     * message using {@link #sendShortMessageData  sendShortMessageData }.<a name="line.448"></a>
<span class="sourceLineNo">449</span>     * &lt;p&gt;<a name="line.449"></a>
<span class="sourceLineNo">450</span>     * @param sender  The email address of the sender.<a name="line.450"></a>
<span class="sourceLineNo">451</span>     * @param recipients  An array of recipient email addresses.<a name="line.451"></a>
<span class="sourceLineNo">452</span>     * @param message  The short email message to send.<a name="line.452"></a>
<span class="sourceLineNo">453</span>     * @return True if successfully completed, false if not.<a name="line.453"></a>
<span class="sourceLineNo">454</span>     * @exception SMTPConnectionClosedException<a name="line.454"></a>
<span class="sourceLineNo">455</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.455"></a>
<span class="sourceLineNo">456</span>     *      of the client being idle or some other reason causing the server<a name="line.456"></a>
<span class="sourceLineNo">457</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.457"></a>
<span class="sourceLineNo">458</span>     *      as an IOException or independently as itself.<a name="line.458"></a>
<span class="sourceLineNo">459</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.459"></a>
<span class="sourceLineNo">460</span>     *      command to the server or receiving a reply from the server.<a name="line.460"></a>
<span class="sourceLineNo">461</span>     ***/<a name="line.461"></a>
<span class="sourceLineNo">462</span>    public boolean sendSimpleMessage(String sender, String[] recipients,<a name="line.462"></a>
<span class="sourceLineNo">463</span>                                     String message)<a name="line.463"></a>
<span class="sourceLineNo">464</span>    throws IOException<a name="line.464"></a>
<span class="sourceLineNo">465</span>    {<a name="line.465"></a>
<span class="sourceLineNo">466</span>        boolean oneSuccess = false;<a name="line.466"></a>
<span class="sourceLineNo">467</span>        int count;<a name="line.467"></a>
<span class="sourceLineNo">468</span><a name="line.468"></a>
<span class="sourceLineNo">469</span>        if (!setSender(sender)) {<a name="line.469"></a>
<span class="sourceLineNo">470</span>            return false;<a name="line.470"></a>
<span class="sourceLineNo">471</span>        }<a name="line.471"></a>
<span class="sourceLineNo">472</span><a name="line.472"></a>
<span class="sourceLineNo">473</span>        for (count = 0; count &lt; recipients.length; count++)<a name="line.473"></a>
<span class="sourceLineNo">474</span>        {<a name="line.474"></a>
<span class="sourceLineNo">475</span>            if (addRecipient(recipients[count])) {<a name="line.475"></a>
<span class="sourceLineNo">476</span>                oneSuccess = true;<a name="line.476"></a>
<span class="sourceLineNo">477</span>            }<a name="line.477"></a>
<span class="sourceLineNo">478</span>        }<a name="line.478"></a>
<span class="sourceLineNo">479</span><a name="line.479"></a>
<span class="sourceLineNo">480</span>        if (!oneSuccess) {<a name="line.480"></a>
<span class="sourceLineNo">481</span>            return false;<a name="line.481"></a>
<span class="sourceLineNo">482</span>        }<a name="line.482"></a>
<span class="sourceLineNo">483</span><a name="line.483"></a>
<span class="sourceLineNo">484</span>        return sendShortMessageData(message);<a name="line.484"></a>
<span class="sourceLineNo">485</span>    }<a name="line.485"></a>
<span class="sourceLineNo">486</span><a name="line.486"></a>
<span class="sourceLineNo">487</span><a name="line.487"></a>
<span class="sourceLineNo">488</span>    /***<a name="line.488"></a>
<span class="sourceLineNo">489</span>     * Logout of the SMTP server by sending the QUIT command.<a name="line.489"></a>
<span class="sourceLineNo">490</span>     * &lt;p&gt;<a name="line.490"></a>
<span class="sourceLineNo">491</span>     * @return True if successfully completed, false if not.<a name="line.491"></a>
<span class="sourceLineNo">492</span>     * @exception SMTPConnectionClosedException<a name="line.492"></a>
<span class="sourceLineNo">493</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.493"></a>
<span class="sourceLineNo">494</span>     *      of the client being idle or some other reason causing the server<a name="line.494"></a>
<span class="sourceLineNo">495</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.495"></a>
<span class="sourceLineNo">496</span>     *      as an IOException or independently as itself.<a name="line.496"></a>
<span class="sourceLineNo">497</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.497"></a>
<span class="sourceLineNo">498</span>     *      command to the server or receiving a reply from the server.<a name="line.498"></a>
<span class="sourceLineNo">499</span>     ***/<a name="line.499"></a>
<span class="sourceLineNo">500</span>    public boolean logout() throws IOException<a name="line.500"></a>
<span class="sourceLineNo">501</span>    {<a name="line.501"></a>
<span class="sourceLineNo">502</span>        return SMTPReply.isPositiveCompletion(quit());<a name="line.502"></a>
<span class="sourceLineNo">503</span>    }<a name="line.503"></a>
<span class="sourceLineNo">504</span><a name="line.504"></a>
<span class="sourceLineNo">505</span><a name="line.505"></a>
<span class="sourceLineNo">506</span><a name="line.506"></a>
<span class="sourceLineNo">507</span>    /***<a name="line.507"></a>
<span class="sourceLineNo">508</span>     * Aborts the current mail transaction, resetting all server stored<a name="line.508"></a>
<span class="sourceLineNo">509</span>     * sender, recipient, and mail data, cleaing all buffers and tables.<a name="line.509"></a>
<span class="sourceLineNo">510</span>     * &lt;p&gt;<a name="line.510"></a>
<span class="sourceLineNo">511</span>     * @return True if successfully completed, false if not.<a name="line.511"></a>
<span class="sourceLineNo">512</span>     * @exception SMTPConnectionClosedException<a name="line.512"></a>
<span class="sourceLineNo">513</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.513"></a>
<span class="sourceLineNo">514</span>     *      of the client being idle or some other reason causing the server<a name="line.514"></a>
<span class="sourceLineNo">515</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.515"></a>
<span class="sourceLineNo">516</span>     *      as an IOException or independently as itself.<a name="line.516"></a>
<span class="sourceLineNo">517</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.517"></a>
<span class="sourceLineNo">518</span>     *      command to the server or receiving a reply from the server.<a name="line.518"></a>
<span class="sourceLineNo">519</span>     ***/<a name="line.519"></a>
<span class="sourceLineNo">520</span>    public boolean reset() throws IOException<a name="line.520"></a>
<span class="sourceLineNo">521</span>    {<a name="line.521"></a>
<span class="sourceLineNo">522</span>        return SMTPReply.isPositiveCompletion(rset());<a name="line.522"></a>
<span class="sourceLineNo">523</span>    }<a name="line.523"></a>
<span class="sourceLineNo">524</span><a name="line.524"></a>
<span class="sourceLineNo">525</span><a name="line.525"></a>
<span class="sourceLineNo">526</span>    /***<a name="line.526"></a>
<span class="sourceLineNo">527</span>     * Verify that a username or email address is valid, i.e., that mail<a name="line.527"></a>
<span class="sourceLineNo">528</span>     * can be delivered to that mailbox on the server.<a name="line.528"></a>
<span class="sourceLineNo">529</span>     * &lt;p&gt;<a name="line.529"></a>
<span class="sourceLineNo">530</span>     * @param username  The username or email address to validate.<a name="line.530"></a>
<span class="sourceLineNo">531</span>     * @return True if the username is valid, false if not.<a name="line.531"></a>
<span class="sourceLineNo">532</span>     * @exception SMTPConnectionClosedException<a name="line.532"></a>
<span class="sourceLineNo">533</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.533"></a>
<span class="sourceLineNo">534</span>     *      of the client being idle or some other reason causing the server<a name="line.534"></a>
<span class="sourceLineNo">535</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.535"></a>
<span class="sourceLineNo">536</span>     *      as an IOException or independently as itself.<a name="line.536"></a>
<span class="sourceLineNo">537</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.537"></a>
<span class="sourceLineNo">538</span>     *      command to the server or receiving a reply from the server.<a name="line.538"></a>
<span class="sourceLineNo">539</span>     ***/<a name="line.539"></a>
<span class="sourceLineNo">540</span>    public boolean verify(String username) throws IOException<a name="line.540"></a>
<span class="sourceLineNo">541</span>    {<a name="line.541"></a>
<span class="sourceLineNo">542</span>        int result;<a name="line.542"></a>
<span class="sourceLineNo">543</span><a name="line.543"></a>
<span class="sourceLineNo">544</span>        result = vrfy(username);<a name="line.544"></a>
<span class="sourceLineNo">545</span><a name="line.545"></a>
<span class="sourceLineNo">546</span>        return (result == SMTPReply.ACTION_OK ||<a name="line.546"></a>
<span class="sourceLineNo">547</span>                result == SMTPReply.USER_NOT_LOCAL_WILL_FORWARD);<a name="line.547"></a>
<span class="sourceLineNo">548</span>    }<a name="line.548"></a>
<span class="sourceLineNo">549</span><a name="line.549"></a>
<span class="sourceLineNo">550</span><a name="line.550"></a>
<span class="sourceLineNo">551</span>    /***<a name="line.551"></a>
<span class="sourceLineNo">552</span>     * Fetches the system help information from the server and returns the<a name="line.552"></a>
<span class="sourceLineNo">553</span>     * full string.<a name="line.553"></a>
<span class="sourceLineNo">554</span>     * &lt;p&gt;<a name="line.554"></a>
<span class="sourceLineNo">555</span>     * @return The system help string obtained from the server.  null if the<a name="line.555"></a>
<span class="sourceLineNo">556</span>     *       information could not be obtained.<a name="line.556"></a>
<span class="sourceLineNo">557</span>     * @exception SMTPConnectionClosedException<a name="line.557"></a>
<span class="sourceLineNo">558</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.558"></a>
<span class="sourceLineNo">559</span>     *      of the client being idle or some other reason causing the server<a name="line.559"></a>
<span class="sourceLineNo">560</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.560"></a>
<span class="sourceLineNo">561</span>     *      as an IOException or independently as itself.<a name="line.561"></a>
<span class="sourceLineNo">562</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.562"></a>
<span class="sourceLineNo">563</span>     *  command to the server or receiving a reply from the server.<a name="line.563"></a>
<span class="sourceLineNo">564</span>     ***/<a name="line.564"></a>
<span class="sourceLineNo">565</span>    public String listHelp() throws IOException<a name="line.565"></a>
<span class="sourceLineNo">566</span>    {<a name="line.566"></a>
<span class="sourceLineNo">567</span>        if (SMTPReply.isPositiveCompletion(help())) {<a name="line.567"></a>
<span class="sourceLineNo">568</span>            return getReplyString();<a name="line.568"></a>
<span class="sourceLineNo">569</span>        }<a name="line.569"></a>
<span class="sourceLineNo">570</span>        return null;<a name="line.570"></a>
<span class="sourceLineNo">571</span>    }<a name="line.571"></a>
<span class="sourceLineNo">572</span><a name="line.572"></a>
<span class="sourceLineNo">573</span><a name="line.573"></a>
<span class="sourceLineNo">574</span>    /***<a name="line.574"></a>
<span class="sourceLineNo">575</span>     * Fetches the help information for a given command from the server and<a name="line.575"></a>
<span class="sourceLineNo">576</span>     * returns the full string.<a name="line.576"></a>
<span class="sourceLineNo">577</span>     * &lt;p&gt;<a name="line.577"></a>
<span class="sourceLineNo">578</span>     * @param command The command on which to ask for help.<a name="line.578"></a>
<span class="sourceLineNo">579</span>     * @return The command help string obtained from the server.  null if the<a name="line.579"></a>
<span class="sourceLineNo">580</span>     *       information could not be obtained.<a name="line.580"></a>
<span class="sourceLineNo">581</span>     * @exception SMTPConnectionClosedException<a name="line.581"></a>
<span class="sourceLineNo">582</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.582"></a>
<span class="sourceLineNo">583</span>     *      of the client being idle or some other reason causing the server<a name="line.583"></a>
<span class="sourceLineNo">584</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.584"></a>
<span class="sourceLineNo">585</span>     *      as an IOException or independently as itself.<a name="line.585"></a>
<span class="sourceLineNo">586</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.586"></a>
<span class="sourceLineNo">587</span>     *  command to the server or receiving a reply from the server.<a name="line.587"></a>
<span class="sourceLineNo">588</span>     ***/<a name="line.588"></a>
<span class="sourceLineNo">589</span>    public String listHelp(String command) throws IOException<a name="line.589"></a>
<span class="sourceLineNo">590</span>    {<a name="line.590"></a>
<span class="sourceLineNo">591</span>        if (SMTPReply.isPositiveCompletion(help(command))) {<a name="line.591"></a>
<span class="sourceLineNo">592</span>            return getReplyString();<a name="line.592"></a>
<span class="sourceLineNo">593</span>        }<a name="line.593"></a>
<span class="sourceLineNo">594</span>        return null;<a name="line.594"></a>
<span class="sourceLineNo">595</span>    }<a name="line.595"></a>
<span class="sourceLineNo">596</span><a name="line.596"></a>
<span class="sourceLineNo">597</span><a name="line.597"></a>
<span class="sourceLineNo">598</span>    /***<a name="line.598"></a>
<span class="sourceLineNo">599</span>     * Sends a NOOP command to the SMTP server.  This is useful for preventing<a name="line.599"></a>
<span class="sourceLineNo">600</span>     * server timeouts.<a name="line.600"></a>
<span class="sourceLineNo">601</span>     * &lt;p&gt;<a name="line.601"></a>
<span class="sourceLineNo">602</span>     * @return True if successfully completed, false if not.<a name="line.602"></a>
<span class="sourceLineNo">603</span>     * @exception SMTPConnectionClosedException<a name="line.603"></a>
<span class="sourceLineNo">604</span>     *      If the SMTP server prematurely closes the connection as a result<a name="line.604"></a>
<span class="sourceLineNo">605</span>     *      of the client being idle or some other reason causing the server<a name="line.605"></a>
<span class="sourceLineNo">606</span>     *      to send SMTP reply code 421.  This exception may be caught either<a name="line.606"></a>
<span class="sourceLineNo">607</span>     *      as an IOException or independently as itself.<a name="line.607"></a>
<span class="sourceLineNo">608</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.608"></a>
<span class="sourceLineNo">609</span>     *      command to the server or receiving a reply from the server.<a name="line.609"></a>
<span class="sourceLineNo">610</span>     ***/<a name="line.610"></a>
<span class="sourceLineNo">611</span>    public boolean sendNoOp() throws IOException<a name="line.611"></a>
<span class="sourceLineNo">612</span>    {<a name="line.612"></a>
<span class="sourceLineNo">613</span>        return SMTPReply.isPositiveCompletion(noop());<a name="line.613"></a>
<span class="sourceLineNo">614</span>    }<a name="line.614"></a>
<span class="sourceLineNo">615</span><a name="line.615"></a>
<span class="sourceLineNo">616</span>}<a name="line.616"></a>




























































</pre>
</div>
</body>
</html>
